Replace Sphinx doc gen with MkDocs and Markdown #592
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR replaces the Sphinx-based reStructuredText (RST) documentation generation system introduced in #418 with MkDocs and Markdown for AWS services only. It also updates the docstring format to use the Google style with Markdown descriptions fro all services (AWS and non-AWS).
Key changes:
Client,Structure,Config,Enum,Union) to output Google style docstrings with Markdown descriptions usingMarkdownConverterAwsMkDocsFileGeneratorplugin to generate MkDocs stub files for only AWS services in theirdocs/directoryAwsRstDocFileGeneratorplugin and RST-to-Markdown conversion logicImportant
This PR only adds standalone docs for individual AWS clients. These can be built in each client and hosted separately. We plan to aggregate these all into a single top-level documentation site in awslabs/aws-sdk-python. This will happen post client generation and will use the stub files generated in
docs/directory for each client. We will also use Material for MkDocs.Testing
aws-sdk-bedrock-runtimeclient and confirmed updates were functionalaws-sdk-bedrock-runtimevisit hereNote
For local testing, please install pandoc v3.8.2 before running code generator.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.